home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_1
/
mach10.zip
/
SYSOP.DOC
< prev
next >
Wrap
Text File
|
1990-07-26
|
18KB
|
410 lines
Mach-10 Documentation
---------------------
This documentation is no where near complete, but for those people who
want to try to set up Mach-10, I've tried to put together enough information
to get you started with a minimum of difficulty. Since this system is complex
and barely documented, I am suggesting that only EXPERIENCED SYSOPS attempt
setting up Mach-10.
Basically, Mach-10 is your average bulletin board system. It offers a
few specialized features that other boards do not offer, and adds a lot of
flexibility that other BBS programs do not have. Here are some of Mach-10's
main features:
- Compatible with both the FIDO (.MSG) message format and my
proprietary HP (High Performance) message system.
- Completely flexible and redefinable menu structure. You may
have as many menus as you like with any options you want on
them.
- Control file setup. 99% of Mach-10's configuration is done from
a control file. This make Mach-10 easily configurable with a
simple text editor.
- Built in call analizer and statistics functions. There are a
variaty of built in statistics commands that allow the users to
see how the system is doing.
- Remote/Local file maintenance section. Mach-10 offers many file
maintenance routines that allow the sysop to move, delete,
zip, view, etc files locally or remotely.
- PackMail system. The PackMail system allows users to bundle
their messages and download them for offline reading.
- Full screen editor. The Full screen editor is the same as that
used by Prodoor, written by Sam H. Smith.
- Powerful message system - The message system includes ReadLocks,
marked messages, searching and scanning, and many other powerful
features.
- Built in CD-ROM capability for using the RBBS-IN-A-BOX CD-ROM.
We're going to add other CD-ROM's as I get them, but currently
the RBBS-IN-A-BOX is the only thing I have tested.
- Sysop message reader. I have included my HPReader package which
is a powerful offline messaage reader, compatible with both the
FIDO and HP formats.
- HP format tosser. If you elect to go with the HP message format,
you can use my HPUTIL message tosser. It functions exactly like
ConfMail/Qmail/etc and tosses into my proprietary message
format. (Note: The HP format is not manditory - Mach-10 is fully
compatible with the standard FIDO format)
- Multinode compatibility - Mach-10 is fully multinode compatible
(I run a two-node system myself) - Mach-10 includes a built-in
multinode chat command.
- Compatible with any doors that use the DORINFOx.DEF format. This
means you can run virtually any door program. (Converters are
available to run Pcboard, Wildcat, WWIV, etc doors)
- Written in Pascal for efficient code. Turbo Pascal offers overlay
support which allows Mach-10 to keep a portion of its code on
disk and only load necessary code on demand. Saves memory!
- Advanced file catalog - stores more information than most
other bbs programs - uploader name, times downloaded, etc.
- Powerful conferences - The conferences allow you to set up
multiple bbs environments. Each conference may have it's own
message areas, file areas, bulletins, menus, etc.
- Extensive user information - Much data is kept on the user -
including statistical information, security parameters, alias,
mailing address, etc.
I suppose the next thing I ought to get to in these docs is the files
that I have included in the package. Here they are:
Included files
--------------
MACH10.EXE - Main executable file for Mach-10
MACH-1.CTL - Sample Mach-1 control file (node #1)
EDITOR.EXE - Mach-10 external editor (not fully completed)
-- EXEBBS.BAT - Sample Frontdoor EXEBBS.BAT to run Mach-10
: FDOOR.BAT - Sample Frontdoor FDOOR.BAT to run Mach-10 (and process mail)
-- AREAS.BBS - My sample AREAS.BBS
:
:---------------- NOTE: These sample files are set up for my HP format
message system. (non-fido)
FILETRAN.BAT - File transfer protocol batch file
BATCHTRA.BAT - Batch protocol file transfer batch file
SIMUL.BAT - Simultanious transfer protocl batch file
MACHARC.BAT - Zip/Zoo/Lzh/Arc/Pak archive support batch file
CALLBAC1 \
CALLBAC2 > Autocallback text files
CALLBAC3 /
MENU.ZIP - Sample Mach-10 menu files
BULLET.ZIP - Sample Mach-10 bulletins
HELP.ZIP - Sample Mach-10 help files
WELCOME.ZIP - Sample Mach-10 welcome files
COMMON.PAS - Pascal source code for Mach-10 variable structures
HPREADER.* - My external message reader (Docs, CTL, and EXE)
SYSOP.DOC - Sysop documentation (this file)
FLINKS.DOC - Partial (incomplete) list of Mach-10 command services
TWARS.BAT - Sample external door batch file
TWARS2.BAT - Sample external door batch file
WWIII.BAT - Sample internal door batch file
MACHRET.BAT - File to return to Mach-10 after an external door
Files that Mach-10 will create
------------------------------
ARCPACKx.M10 - Packaged user mail (archived ver)
ANALIZEx.M10 - Call analizer data file
CALLERSx.M10 - Callers file (plain text)
CHAT.M10 - Multiuser chat data file
DORINFOx.DEF - Door information file
FILECAT.M10 - Files system file catalog
NODES.M10 - Node status information
PACKx.M10 - Packaged user mail (plain-text ver)
USERS.M10 - User file (holds all user data)
(NOTE: Filenames with a small "x" in them indicate that the "x" is a
node number (i.e. "1", "2", etc)
MY SETUP
--------
In order for you to understand how things work, I have included the
control file and batch files directly from my bbs. Here's a basic run-down
of what the disk structure on my node #1 looks like:
I:\ -------- MACH10 ---------------- MENU (Menu files )
: :
: ------------- HELP (Help files )
: :
: ------------- BULLET (Bulletins )
: :
: ------------- WELCOME (Welcome files )
: :
: ------------- MISCTEXT (Misc. text files )
: :
: ------------- TWARS (Galactic Warzone #1)
: :
: ------------- TWARS2 (Galactic Warzone #2)
:
:
----- SCOTTBBS -------------- EXTPROTO (External protocols )
:
:
----- CDROM (CD-ROM support)
:
:
----- BINKLEY --------------- NODELIST (Nodelist files )
:
------------- MESSAGES (Messages )
The five ZIP files I have included can go directly into their
respective directories (MENU,HELP,BULLET,WELCOME,MISCTEXT). Most of the other
junk should go into the Mach-10 directory. You'll probably be installing
into a drive other than I: so you'll need to edit the Mach-10 control
file (MACH-1.CTL) to reflect your changes.
Although my mailer's directory is called BINKLEY, I am actually
running FRONT-DOOR. I have included my FDOOR.BAT, EXEBBS.BAT, and AREAS.BBS
files from my system.
A few more things you might be interested in - I have a 2400 baud
modem and it is plugged into COM1. I am running a color (EGA) system.
THE CONTROL FILE
----------------
Read the control file! It has information that is more important than
what is in here!
NOTES ABOUT MACH-10
-------------------
Since I am rushing these docs, I am going to write down a series of
general important things below. The points below are not in any specific
order, but they are all more or less important.
CONTROL FILE
The Mach-10 control file (Mach-1.ctl) contains much information that
is not present in this document. Read it! It is important!
CALLING UP MACH-10
99.9% of the time Mach-10 requires a node-number as the first parameter
on the command line. (This is not a FIDONET node number, but a node number as
in networking). For most purposes, this will be a "1". Examples:
MACH10 1 /L Local Logon
MACH10 1 /S Sysop Logon
MACH10 1 /M Message renumbering
FRONT-END
The front end (i.e. binkley or front door) is necessary for the
operation of Mach-10. Mach-10 itself has no routines for answering the phone,
the Front-end handles answering the phone, processing any mail, etc. If you
already are using a bbs program that uses a front-end, then setting it up
should be a breaze. If not, then you should probably stop now and acquire
a front-end and set it up before proceding.
RENUMBERING
Mach-10 needs to renumber it's messages on a nighty basis. You will
need to set up an EVENT from your Front-End to exit sometime during the night
and in a batch file perform the following options in this order:
1) Somehow delete old messages. Confmail version 3.x will handle
this nicely. DO NOT renumber yet
2) Go into the Mach-10 directory and run Mach-10 with the /M switch
(i.e. MACH10 1 /M). Mach-10 will then adjust all of the user's
lastread pointers.
3) Now, do the actual renumbering. Confmail version 3.x will also
handle this nicely.
There is one way in which Mach-10 will perform all of the above
procedures itself. In this mode, uncomment the "SHELLTOCONFMAIL" parameter
in the in Mach-10. Then, Mach-10 will shell and run confmail to do steps
1 and 3. All you will need to do then is step #2. (run Mach-10 with the
/M parameter)
1) You must have a copy of your AREAS.BBS in you mach-10 directory,
along with any other files that confmail needs.
2) Confmail must either be in the Mach-10 directory or accessable
with the dos path command.
3) You must be using confmail version 3.x, not 4.x.
MULTINODE USE
Mach-10 is fully multinode capable. Each node will require a seperate
control file (Mach-1.ctl, Mach-2.ctl, Mach-3.ctl, etc) and you may need
a seperate copy of the EXE file for each node.
EDITER.EXE
Editor.Exe is the Mach-10 external sysop editor. It includes a file
and user editor, and an event editor (although the Mach-10 does not support
events at this time).
The file and user editors are very useful and slightly more
powerful to the internal ones built into Mach-10.
EXTERNAL PROTOCOLS
I use DSZ.EXE for most of my protocols, but also use BIMODEM, CLINK,
PCKERMIT, and a few others. The external protocols are all called through
one of three batch files: Filetran.bat, batchtra.bat, or simul.bat. Look
at these files for more information.
INTERFACE BATCH FILES
Several batch files are included which I call "interface batch files".
These files handle the interface between Mach-10 and various other
necessary files. This includes mainly the external file transfer protocols
and the ZIP/ARC/LZH/ZOO/PAK support. Here are the batch files and what
they do:
MACHARC.BAT
This batch file provides support for various archiving programs.
Mach-10 will pass a command to the batch file and then the
batch file operates on the command. Commands include ARC viewing,
testing, converting to ZIPs, etc.
FILETRAN.BAT
This file handles all non-batch transfers. You may have to edit
this file to change various path's to reflect your system.
BATCHTRA.BAT
This file handles all batch protocol transfers. (i.e. Batch zmodem,
ymodem-batch, etc)
SIMUL.BAT
Simul.bat is a special file for handling BIMODEM simultanious
transfers.
DOORS
The control file includes a lot of information on both external and
shelled doors, but I will add a closer more in-depth look here. Basically,
Mach-10 uses the DORINFOx.DEF method of passign door parameters. (The DORINFO
method is also used by RBBS, QUICKBBS, and other bbs programs).
Mach-10 will create a DORINFOx.DEF when ever it shells or exits to
a door. The "x" stands for the node number and will usually be "1" in most
(non-multinode) situations. DORINFOx.DEF contains almost all necessary
information for operating the door - The user's first and last name,
baud rate, etc.
Mach-10 also passes some parameters on the command line to the batch
file. This includes the Baud, Time left, a "0", the user's first and
last name, and the graphics the user has selected. For ANSI graphics,
Mach-10 will send a "1" for non-ANSI, mach-10 will send a "0".
For example, suppose we were calling TWARS.BAT, John Doe was online at 2400
baud, had 30 minutes left, and was running ANSI. Mach-10 would execute the
following: "TWARS.BAT 2400 30 0 JOHN DOE 1". The parameters in most cases
are not necessary, but if you need to write custom door interfaces yourself,
these parameters could make your job a bit easier.
For shelled doors (see the control file), Mach-10 simply shells and
executes the command line above. For external doors, the process is a bit
more complicated.
EXTERNAL DOORS
External doors are doors that Mach-10 must exit to rather than shell
to because they require too much memory to be run shelled. Mach-10 implements
external doors through a batch file type system. A special file called
"MACHDOR"+(node num)+'.BAT' will be created containing the same command
line that Mach-10 would have executed for a shelled door. Your EXEBBS.BAT
must then execute the MACHDORx.BAT file which in turn executes the
door batch file, and then executes the batch file MACHRETx.BAT.
All of this can best be explained with an example. Suppose you
were running my Galactic Warzone door game externally. Again, suppose that
John Doe was on at 2400 baud with ansi graphics and 30 mins of time.
[------ EXEBBS.BAT, MACH-10.BAT, or whatever calls Mach-10 -----]
cd \MACH10 ; Change to Mach-10 dir
if exist MACHDOR1.BAT del MACHDOR1.BAT ; Kill old bat if present
MACH10 1 %2 %1 ; Run Mach-10
if exist MACHDOR1.BAT MACHDOR1.BAT ; Run the bat if it exists
cd \fdoor ; Get back to frontdoor dir
fdoor ; Run front-doors bat file
[---------------------------------------------------------------]
[------ MACHDOR1.BAT -------------------------------------------]
TWARS.BAT 2400 30 0 JOHN DOE 1 ; Run the door batch file
[---------------------------------------------------------------]
[------ TWARS.BAT ----------------------------------------------]
cd \mach10\twars ; Get into my GW directory
copy \mach10\dorinfo1.def ; Copy over the dorinfo
twars 1 ; Run GW with node #1
cd \mach10 ; Get back to Mach-10 directory
MACHRET.BAT ; Return to Mach-10
[---------------------------------------------------------------]
[------ MACHRET.BAT --------------------------------------------]
cd \fdoor ; Get to front-door dir
EXEBBS.BAT 255 255 ; Reload Mach-10
; The 255's tell Mach-10 we are
; returning from a door
[---------------------------------------------------------------]
NOTE: The ";" comments are invalid in batch files, but I added them to this
document for clarity.
EXEBBS.BAT is the batch file that is used to run Mach-10. The
front end mailer (i.e. Front-Door or Binkley) runs this file with the
baud rate and comport on the command line. (i.e. "EXEBBS.BAT 2400 1")
This file must delete the existing MACHDORx.BAT file if it is present,
runs Mach-10, and if Mach-10 creates a MACHDORx.BAT file, then Mach-10
executes it.
The last file, MACHRET.BAT requires some additional explanation. What
it does is call up EXEBBS.BAT which in turn loads Mach-10 (node #1) again,
but with the parameters 255 and 255 as the baud rate and com port. When these
two variables are set to 255, Mach-10 recognizes that we are returning from
an external door and re-loads the user data and correct baud/comport
information from it's own data files.
MULTINODE AND DOORS
Most doors only support one node at a time (My Galactic Warzone
included). Therefore, you must either only have these doors on one node or
work up some kind of scheme to keep users from trying to go into the same
door at the same time from different nodes. Here are a few cautions for
using doors on a multinode system.
1) Mach-10 will create different DORINFOx.DEF and MACHDORx.BAT for
different nodes.
2) You will probably need a seperate EXEBBS.BAT for each node.
3) You will probably need a seperate MACHRET.BAT for each node.
LOCAL LOGON
You may log into Mach-10 locally with the "/L" switch. You must also
specify the node umber as the first parameter on the command line. For
example: "MACH10 1 /L".
There is also a special sysop fast-logon option. The "/S" parameter
will log the sysop on and bypass the majority of the services during logon.
For example: "MACH10 1 /S".